Skip to main content

StudioAPI Methods

An object defining methods for the StudioAPI class.

GetDeployments(projectRequest, telemetryCollectorHolder)​

Retrieves deployment details for a specified project. Executes a POST request to fetch deployment information based on the provided project request.

Parameters:​

projectRequest (required): GetProjectDeploymentsRequest
The request object containing parameters for retrieving deployments.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Optional telemetry collector for gathering execution metrics.

Returns:​

Type: Task<WrapResponse<GetProjectDeploymentsResponse>>
A Task that represents the asynchronous operation, with a result of GetProjectDeploymentsResponse, containing deployment details for the project.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​

GetProcesses(processesRequest, telemetryCollectorHolder)​

Retrieves process details for a specified project. Executes a POST request to fetch process information based on the provided processes request.

Parameters:​

processesRequest (required): GetProcessesRequest
The request object containing parameters for retrieving processes.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Optional telemetry collector for gathering execution metrics.

Returns:​

Type: Task<WrapResponse<GetProcessesResponse>>
A Task that represents the asynchronous operation, with a result of 'GetProcessesResponse', containing process details for the project.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​

GetFlows(flowsRequest, telemetryCollectorHolder)​

Retrieves flow details for a specified project. Executes a POST request to fetch flow information based on the provided flows request.

Parameters:​

flowsRequest (required): GetFlowsRequest
The request object containing parameters for retrieving flows.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Optional telemetry collector for gathering execution metrics.

Returns:​

Type: Task<WrapResponse<GetFlowsResponse>>
A Task that represents the asynchronous operation, with a result of GetFlowsResponse, containing flow details for the project.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​

GetProjects(projectRequest, telemetryCollectorHolder)​

Retrieves a list of projects available in the Studio. Executes a POST request based on the provided project request.

Parameters:​

projectRequest (required): GetProjectsRequest
The request object containing parameters for retrieving projects.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Optional telemetry collector for gathering execution metrics.

Returns:​

Type: Task<WrapResponse<GetProjectsResponse>>
A Task that represents the asynchronous operation, with a result of GetProjectsResponse, containing a list of projects.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​

GetVersionByProcessId(projectRequest, telemetryCollectorHolder)​

Retrieves the version information associated with a specific process ID. Executes a POST request to get version details based on the provided process ID request.

Parameters:​

projectRequest (required): GetVersionByProcessIdRequest
The request object containing parameters for retrieving version details by process ID.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Optional telemetry collector for gathering execution metrics.

Returns:​

Type: Task<WrapResponse<GetVersionByProcessIdResponse>>
A Task that represents the asynchronous operation, with a result of GetVersionByProcessIdResponse, containing version information for the specified process ID.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​